Skip to main content

vpnDescribe

Description

vpn describe.

Request Method

GET

Request Path

/customer/vpn/describe

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
instanceIdQueryStringYesNo sample value for this parameter. instance id
regionIdQueryStringYesNo sample value for this parameter. region id

Return data

NameTypeSample valueDescription
resultobject`{"instanceId":"VPN-NRP339782378999668736","gatewayName":"TheCurrentVpnName","regionId":"cn-wulan-sta1-d01","vpcId":"vpc-nj3ptd8vtuyyoh08idhne/zcw","billingMethod":"Subscription","expiredTime":1.6615296E+12,"capacity":1024.0}`No description for this parameter.
resultCodestring0result code
resultMsgstringsuccessresult message

Example

Successful Response example

{
"result":
{
"instanceId":"VPN-NRP339782378999668736",
"gatewayName":"TheCurrentVpnName",
"regionId":"cn-wulan-sta1-d01",
"vpcId":"vpc-nj3ptd8vtuyyoh08idhne/zcw",
"billingMethod":"Subscription",
"expiredTime":1.6615296E+12,
"capacity":1024.0
},
"resultCode":"0",
"resultMsg":"success"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}